In This Topic
Resource Path: /rest/rate-period/{companyId}/{userId}/{ratePeriodId}
Summary
Parameters
| Name | Description | Data Type |
|---|
| companyId | companyId | string |
| userId | userId | string |
| ratePeriodId | ratePeriodId | string |
200 Response
The response body is of type RatePeriod.
OK
Overview
 |
RatePeriod
 |
adjustmentHackActivated : boolean
|
 |
|
actionMapper : object
|
 |
adKey : Array[string]
|
|
adjGrpKey : Array[string]
|
|
adjTableKey : Array[string]
|
|
daylock : integer
|
|
|
counter : integer
internal only |
|
date : string
The current date.
internal only |
|
machineIdentifier : integer
internal only |
|
processIdentifier : integer
internal only |
|
time : integer
internal only |
|
timeSecond : integer
internal only |
|
timestamp : integer
internal only | |
|
importTypeMapByPattern : object
|
|
polarityInvertMapByAdjustmentType : object
|
|
preventImportIfNoRateGrid : boolean
| |
|
allDayLocks : Array[integer]
|
|
allowPriceInterpolation : boolean
|
|
applyFinalNoteRateFloorCeiling : boolean
|
|
applyParRounding : boolean
|
|
|
autoExpireExemptDates : Array[UsDateState]
|
|
|
amPm : boolean
|
|
hour : string
|
|
minute : string
| |
|
|
|
calendarType : string
|
|
id : string
| |
|
dayOfMonth : integer
|
|
dayOfWeek : string
|
|
dayOfYear : integer
|
|
hour : integer
|
|
minute : integer
|
|
month : string
|
|
monthValue : integer
|
|
nano : integer
|
|
second : integer
|
|
year : integer
| |
|
expireOption : string
|
|
expireSaturday : boolean
|
|
expireSunday : boolean
|
|
holidayExemptDates : Array[HolidayDate]
|
|
shouldExpireRatePeriod : boolean
|
|
timezone : string
| |
|
autoImportClz : string
|
|
autoImportClzLLPA : string
|
|
autoImportProperties : object
|
|
autoImportWhenNewFileIsUploaded : boolean
|
|
autoVerifyImportClz : string
|
 |
|
adjustmentHackActivated : boolean
|
|
allDayLocks : Array[integer]
|
|
allowPriceInterpolation : boolean
|
|
applyFinalNoteRateFloorCeiling : boolean
|
|
applyParRounding : boolean
|
|
autoImportClz : string
|
|
autoImportClzLLPA : string
|
|
autoImportProperties : object
|
|
autoImportWhenNewFileIsUploaded : boolean
|
|
autoPushTime : string
|
|
autoVerifyImportClz : string
|
|
comment : string
|
|
compPlan : number
|
|
compPlanDollarRange : CreditDollarRange
|
|
compPlanScript : string
|
|
|
active : boolean
|
|
|
censustract : string
Property ID in the national census data. |
|
city : string
City where the property is located. |
|
country : string
Country where the property is located. |
|
county : string
County where the property is located.
This is used for countyFips. The best practice is to pass to alleviate issues when the same zip/state spans > 1 county (counties may have different loan limits).
Must pass state fips + county fips. Example, 25017 for Middlesex County, MA; 36103 for Suffolk, NY. |
|
countyFips : string
CountyFips ID.
Populate this field if you are concerned that the state and zip area spans more than one county, in which case the API will only return the first county in the list. |
|
countyName : string
Name of the county the property is located in. |
|
defaultZipFipsComboOnMismatch : boolean
|
|
latitude : number
Property latitude. |
|
longitude : number
Property longitude. |
|
msa : string
|
|
province : string
The province where the property is located. |
|
state : string
The state where the property is located.
Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the countyFips. |
|
stateFips : string
This field is DEFUNCT.
DO NOT USE. |
|
street : string
The first line of the property street address.
Example: 10 Rose Court |
|
streetCont : string
The second line of the property street address.
Example: Apt. C |
|
zip : string
The property zip code.
Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the countyFips. |
|
zipExt : string
The four digit zip code area extension. The dash is not necessary.
Example: 2435
Do not enter in this format: -2435
| |
|
allowPublicReview : boolean
|
|
apiSecret : string
|
|
armRoundedFullyIndexedRate : boolean
|
|
authenticationURL : string
|
|
autoExpireLoan : boolean
|
|
autoSync : boolean
|
|
batchPricingCallbackURL : string
|
|
blacklisted : boolean
|
|
|
active : boolean
|
|
|
displayText : string
|
|
value : string
| |
|
closestToPar : boolean
|
|
closestToTargetValue : number
|
|
closestToTargetValueFrom : number
|
|
closestToTargetValueTo : number
|
|
companyId : string
|
|
companyName : string
|
|
|
answerDataType : string
|
|
controlType : string
|
|
customQuestionId : string
|
|
defaultAnswerValue : string
|
|
displayText : string
|
|
grouping : string
|
|
hiddenInUserInterface : boolean
|
|
intMaxValue : integer
|
|
intMinValue : integer
|
|
integrationFieldPath : string
|
|
loanPurposes : Array[string]
|
|
maxSelections : integer
|
|
mergePriority : integer
|
|
minSelections : integer
|
|
order : integer
|
|
path : string
|
|
placeholder : string
|
|
questionType : string
|
|
readOnly : boolean
|
|
required : boolean
|
|
|
comparison : string
|
|
customQuestionId : string
|
|
integrationFieldPath : string
|
|
value : string
|
|
values : Array[string]
| |
|
stringMaxLength : integer
|
|
stringMinLength : integer
|
|
unusedByAdapter : boolean
|
|
userType : string
| |
|
defaultAmortizationType : Array[string]
|
|
defaultArmFixedTerms : Array[string]
|
|
defaultDayLock : object
|
|
defaultLoanTerms : Array[string]
|
|
defaultMortgageTypes : Array[string]
|
|
lenderpriceApiKey : string
|
|
maxCompensation : number
|
|
minimumCompensation : number
|
|
originationFeeFromAdjustment : boolean
|
|
purchaseAffordabilityProducts : Array[string]
|
|
showDisqualify : boolean
|
|
showDisqualifyRules : boolean
|
|
tenantId : string
|
|
tenantName : string
|
|
useDefaultEstimatedMi : boolean
|
|
useDisplayName : boolean
|
|
userId : string
| |
|
|
active : boolean
|
|
closestToPar : boolean
|
|
closestToTargetValue : number
|
|
closestToTargetValueFrom : number
|
|
closestToTargetValueTo : number
|
|
companyId : string
|
|
companyName : string
|
|
defaultAmortizationType : Array[string]
|
|
defaultArmFixedTerms : Array[string]
|
|
defaultDayLock : object
|
|
defaultLoanTerms : Array[string]
|
|
defaultMortgageTypes : Array[string]
|
|
lenderpriceApiKey : string
|
|
maxCompensation : number
|
|
minimumCompensation : number
|
|
originationFeeFromAdjustment : boolean
|
|
purchaseAffordabilityProducts : Array[string]
|
|
showDisqualify : boolean
|
|
showDisqualifyRules : boolean
|
|
tenantId : string
|
|
tenantName : string
|
|
useDefaultEstimatedMi : boolean
|
|
useDisplayName : boolean
|
|
userId : string
| |
|
broker : boolean
|
|
|
creationDate : string
|
|
|
creationDate : string
|
|
description : string
|
|
modifiedByOverride : string
|
|
name : string
|
|
roles : Array[string]
| |
|
modifiedByOverride : string
| |
|
computeCompPlanWithTotalLoanAmt : boolean
|
|
contactDetails : ContactDetails
|
|
contactPerson : ContactPerson
|
|
creationDate : string
|
|
customFields : object
|
|
customFiles : object
|
|
dataWriteURL : string
|
|
defaultTurnTimes : Array[TurnTime]
|
|
defaultUserPictureLink : string
|
|
demo : boolean
|
|
ein : string
|
|
ernstPassword : string
|
|
ernstUserName : string
|
|
expandedEligibilityHWURL : string
|
|
expandedEligibilityURL : string
|
|
externalLogo : string
|
|
feeAPIURL : string
|
|
feeAPIURLAlternate : string
|
|
feeAPIURLBatch : string
|
|
footerPhrase : string
|
|
|
annualMiPremium : boolean
|
|
fundingFee : boolean
|
|
guaranteeFee : boolean
|
|
ufmipFee : boolean
| |
|
handleLock : boolean
|
|
headerPhrase : string
|
|
includeExtendedRatesInLenderFilter : boolean
|
|
|
key : string
|
|
value : string
| |
|
jsonCustomFiles : Array[JsCompanyFieldFile]
|
|
jsonSystemAdminFields : Array[JsField] |
|
ldapAPIURL : string
|
|
lender : boolean
|
|
linkSmoToDynamicFields : boolean
|
|
loadLoanAPIURL : string
|
|
marketPlace : boolean
|
|
marketPlaceNewUrl : string
|
|
modifiedByOverride : string
|
|
name : string
|
|
nmlsId : string
|
|
otherContacts : Array[ContactPerson]
|
|
partnerData : PartnerData
|
|
passwordExpirationDays : integer
|
|
priceExceptionFormURL : string
|
|
priceExceptionURL : string
|
|
|
computationService : string
|
|
rateLimiterByFeature : object
| |
|
pricingProjection : Array[string]
|
|
qmTreshold : Number
|
|
|
autoGenerateRateSheets : boolean
|
|
notificationEmails : Array[string]
|
|
rateSheetFilename : string
|
|
rateSheetGenerationType : string
|
|
separateByGroupId : boolean
|
|
sftpDirectories : Array[string]
|
|
sftpDirectory : string
|
|
sftpHostname : string
|
|
sftpPassword : string
|
|
sftpSalt : string
|
|
sftpUsername : string
|
|
urlDomainDownload : string
|
|
zipFilename : string
|
|
zipFiles : boolean
| |
|
|
scoreMap : object
|
|
totalReviewScore : integer
|
|
totalReviews : integer
| |
|
redirectAtLogin : boolean
|
|
shortName : string
|
|
ssoIdentifier : string
|
|
tags : Array[string]
|
|
userGroupMortgageMarketPlace : string
|
|
website : string
|
|
writebackURL : string
| |
|
companyAdjustmentGroupProperties : object
|
|
companyAdjustmentGroupsApplyToRateGridIds : object
|
|
companyQuashSettingApplyToRateGridIds : object
|
|
companyQuashSettingProperties : object
|
|
conditions : Array[Condition]
|
|
createdFromCompanyName : string
|
|
createdFromRatePeriodValidAs : string
|
|
creationDate : string
|
|
|
description : string
|
|
filename : string
|
|
md5 : string
|
|
objectId : string
|
|
tag : string
|
|
uploadDate : string
|
|
uploadedBy : string
| |
|
customDisplayLenderName : string
|
|
defaultAdminFee : number
|
|
description : string
|
|
expired : boolean
|
|
expiredAll : boolean
|
|
fees : Array[Fee]
|
|
fhaLoanLimitYearOverride : integer
|
|
ficoModifierCapRange : IntegerRangeLeGe
|
|
fileKeyForAutoImport : string
|
|
fileKeyForAutoImportLLPA : string
|
|
fileKeyForAutoVerify : string
|
|
filterName : string
|
|
globalAdjustmentGroupProperties : object
|
|
globalAdjustmentGroupsApplyToRateGridIds : object
|
|
globalCapRateGridsMap : object
|
|
hedgeEnabled : boolean
|
|
holdBack : number
|
|
holdBackDescription : string
|
|
importEnable : boolean
|
|
importedOldLLPAFileId : string
|
|
importedOldRateFileId : string
|
|
importedRatePeriod : boolean
|
|
isExpired : boolean
|
|
isExpiredAll : boolean
|
|
isPublic : boolean
|
|
isPublish : boolean
|
|
lastFileIdUsedToUpdateThisRate : ObjectId |
|
lastFileUsedToUpdateThisRate : CompanyCustomFileField
|
|
lastFileUsedToUpdateThisRateLLPA : CompanyCustomFileField
|
|
liborAdjustmentApplyToRateGridIds : object
|
|
limitCode : string
|
|
linkedCompanyAdjustmentGroupsApplyToRateGridIds : object
|
|
loanLimitYearOverride : integer
|
|
|
creationDate : string
|
|
days : integer
|
|
modifiedByOverride : string
|
|
points : number
| |
|
lockStatusPolicyId : string
|
|
|
from : number
The minimum value for the range. |
|
to : number
The maximum value for the range. | |
|
mapColumnsToExclude : object
|
|
mapDayRate : object
|
|
mapListImports : object
|
|
maxCompensation : number
|
|
maxCompensationDollarAmount : number
|
|
maxCompensationScript : string
|
|
modifiedByOverride : string
|
|
myCompanyAdjustmentGroupProperties : object
|
|
myCompanyAdjustmentGroupsApplyToRateGridIds : object
|
|
name : string
|
|
newCreatedFromRatePeriodValidAs : string
|
|
note : string
|
|
originalModifiedDate : string
|
|
|
excludeHolidayOrExemptToggle : boolean
|
|
exemptDatesConfig : Array[UsDateState]
|
|
|
hrs : integer
|
|
mins : integer
| |
|
holidayDatesConfig : Array[HolidayDate]
|
|
timezone : string
|
|
|
overrideFieldSet : Array[string]
|
|
parentRateOrCompanyInvalid : boolean
|
|
programAdjustmentHackActivated : boolean
|
|
properties : Array[FieldProperty]
|
|
public : boolean
|
|
publish : boolean
|
|
qualifiedTypes : Array[string]
|
|
|
adjustmentCategoryType : string
|
|
applyToAll : boolean
|
|
|
counter : integer
internal only |
|
date : string
The current date.
internal only |
|
machineIdentifier : integer
internal only |
|
processIdentifier : integer
internal only |
|
time : integer
internal only |
|
timeSecond : integer
internal only |
|
timestamp : integer
internal only | |
|
autoApplyToNewRateGrid : boolean
|
|
code : string
|
|
creationDate : string
|
|
disqualifyIfQualifier : boolean
|
|
enabled : boolean
|
|
encompassLink : boolean
|
|
includeZeroValuedAdjustments : boolean
|
|
loanInfoAdjustment : LoanInfoAdjustment
|
|
maxCompensation : number
|
|
maxCompensationDescription : string
|
|
maxCompensationScript : string
|
|
modifiedByOverride : string
|
|
name : string
|
|
order : integer
|
|
rateAdjustmentType : string
|
|
rateAdjustments : Array[RateAdjustment]
|
|
showOnRateGenerator : boolean
| |
|
|
|
|
|
|
|
|
applyParRounding : boolean
|
|
code : string
|
|
creationDate : string
|
|
effectiveDate : string
|
|
enabled : boolean
|
|
expirationDate : string
|
|
externalName : string
|
|
lockGroup : string
|
|
modifiedByOverride : string
|
|
name : string
|
|
order : integer
|
|
overrideFieldSet : Array[string]
|
|
parentName : string
|
|
|
adjustmentCap : number
|
|
adjustmentCapScript : string
|
|
affordableHousingTypes : Array[string]
|
|
agency : string
|
|
allowedLockGroupChange : Array[string]
|
|
amortizationTerms : integer
|
|
armCaps : string
|
|
armCeiling : number
|
|
armChangeDates : Array[integer]
|
|
armFloorRateFlatValue : number
|
|
armFloorRateType : string
|
|
armLookbackPeriod : integer
|
|
armMargin : number
|
|
armRoundingFactor : string
|
|
armRoundingStractegy : string
|
|
assumption : boolean
|
|
aus : Array[string]
|
|
businessSourceTypes : Array[string]
|
|
closingDays : Array[integer]
|
|
closingDaysAvailable : Array[integer]
|
|
closingDaysShiftMap : object
|
|
compPlan : number
|
|
compPlanDollarRange : CreditDollarRange
|
|
copy : boolean
|
|
creationDate : string
|
|
customFieldMap : object
|
|
daysLockMapping : object
|
|
deactivateMi : boolean
|
|
displayName : string
|
|
disqualified : Array[string]
|
|
disregardFhaLoanLimit : boolean
|
|
dueTerms : integer
|
|
effectiveDate : string
|
|
enable : boolean
|
|
enableMiOverwrite : boolean
|
|
excludeInInterpolationCalc : boolean
|
|
expirationDate : string
|
|
fhaLoanType : string
|
|
ficoModifierCapRange : IntegerRangeLeGe
|
|
fixPaymentOption : string
|
|
gridType : string
|
|
hedgeEnabled : boolean
|
|
holdBack : number
|
|
holdBackDescription : string
|
|
importDeleteWhenNotFound : boolean
|
|
interestOnlyMonth : integer
|
|
libor : string
|
|
liborMigratedtoLiborType : boolean
|
|
liborNameConvertedToLiborType : boolean
|
|
liborType : string
|
|
lienPriorityType : string
|
|
limited : boolean
|
|
listOfRateGridSelectedForBlendingWithInfo : object
|
|
|
from : number
|
|
null : boolean
|
|
to : number
| |
|
loanPlanId : string
|
|
loanPurposes : Array[string]
|
|
loanType : string
|
|
lockGroup : string
|
|
maxCompensation : number
|
|
maxCompensationDollarAmount : number
|
|
maxCompensationScript : string
|
|
maxExportRate : number
|
|
minExportRate : number
|
|
minimumMonthlyPaymentAmount : number
|
|
minimumMonthlyPaymentPercentage : number
|
|
modifiedByOverride : string
|
|
mortgageLimits : Array[string]
|
|
mortgageTypes : Array[string]
|
|
|
dataMatrix : Array[array]
|
|
defaultDayLock : integer
|
|
defaultPrice : number
|
|
xAxis : Array[Range«object»]
|
|
xAxisDataTyep : string
|
|
xAxisName : string
|
|
yAxis : Array[Range«object»]
|
|
yAxisDataTyep : string
|
|
yAxisName : string
| |
|
name : string
|
|
nameCombination : string
|
|
note : string
|
|
order : integer
|
|
originalRates : Array[Rate]
|
commissionMapByClosingDay : object
|
|
offsheet : boolean
|
|
rate : number
|
|
shiftAdjGroupId : string
|
|
sourceRate : number
| |
|
originalesRates : Array[Rate] |
|
overrideFieldSet : Array[string]
|
|
parallelIO : boolean
|
|
pmiThreshold : number
|
|
pmiTypes : Array[string]
|
|
productCode : string
|
|
propertyTypes : Array[string]
|
|
qmTypes : Array[string]
|
|
|
calculationType : string
|
|
|
flat : number
|
|
noteSource : string
| |
|
useQualRate : boolean
| |
|
rateGridBlendingActivated : boolean
|
|
rateShift : number
|
|
|
flatFee : number
|
|
holdbackMapByClosingDay : object
|
|
msr : number
|
|
msrMapByClosingDay : object
|
|
otherMapByClosingDay : object
|
|
rate : number
|
|
rateIdx : number
| |
|
|
category : string
The category of the special mortgage option. |
|
description : string
Description of the mortgage option. |
|
dynamicProperties : object
|
|
enabled : boolean
Set to True if enabled. |
|
id : ObjectId
The mortgage option ID, used for reference. |
|
name : string
Name of the special mortgage option. | |
|
specialtyProduct : string
|
|
terms : Array[integer]
|
|
termsInMonths : boolean
|
|
vaLoanType : string
|
|
varaiableLoanTypes : Array[string]
|
|
yearlyTerm : number
| | |
|
|
|
rateSheetCompareOnFileReplaced : boolean
|
|
rateType : string
|
|
scriptWeight : integer
|
|
showCompanyName : boolean
|
|
showInProBrokerLink : boolean
|
|
skipConstructionPeriod : boolean
|
|
states : string
|
|
statesSet : Array[string]
|
|
stepRate : number
|
|
subRateType : string
|
|
timeTracking : TimeTrackingHandler
|
|
useInvestorLockPolicy : boolean
|
|
vaLoanLimitYearOverride : integer
|
|
validAsOf : string
| |
|
compPlan : number
|
|
compPlanDollarRange : CreditDollarRange
|
|
compPlanScript : string
|
|
companyAdjustmentGroupProperties : object
|
|
companyAdjustmentGroupsApplyToRateGridIds : object
|
|
companyQuashSettingApplyToRateGridIds : object
|
|
companyQuashSettingProperties : object
|
|
conditions : Array[Condition]
|
|
creationDate : string
|
|
customDisplayLenderName : string
|
|
defaultAdminFee : number
|
|
description : string
|
|
expired : boolean
|
|
expiredAll : boolean
|
|
fees : Array[Fee]
|
|
fhaLoanLimitYearOverride : integer
|
|
ficoModifierCapRange : IntegerRangeLeGe
|
|
fileKeyForAutoImport : string
|
|
fileKeyForAutoImportLLPA : string
|
|
fileKeyForAutoVerify : string
|
|
filterName : string
|
|
globalAdjustmentGroupProperties : object
|
|
globalAdjustmentGroupsApplyToRateGridIds : object
|
|
globalCapRateGridsMap : object
|
|
hedgeEnabled : boolean
|
|
holdBack : number
|
|
holdBackDescription : string
|
|
importEnable : boolean
|
|
importedOldLLPAFileId : string
|
|
importedOldRateFileId : string
|
|
importedRatePeriod : boolean
|
|
isExpired : boolean
|
|
isExpiredAll : boolean
|
|
isPublic : boolean
|
|
isPublish : boolean
|
|
lastFileIdUsedToUpdateThisRate : ObjectId |
|
lastFileUsedToUpdateThisRate : CompanyCustomFileField
|
|
lastFileUsedToUpdateThisRateLLPA : CompanyCustomFileField
|
|
liborAdjustmentApplyToRateGridIds : object
|
|
limitCode : string
|
|
linkedCompanyAdjustmentGroupsApplyToRateGridIds : object
|
|
loanLimitYearOverride : integer
|
|
lockStatusPolicyId : string
|
|
mapColumnsToExclude : object
|
|
mapDayRate : object
|
|
mapListImports : object
|
|
maxCompensation : number
|
|
maxCompensationDollarAmount : number
|
|
maxCompensationScript : string
|
|
modifiedByOverride : string
|
|
name : string
|
|
note : string
|
|
overrideFieldSet : Array[string]
|
|
programAdjustmentHackActivated : boolean
|
|
properties : Array[FieldProperty]
|
|
public : boolean
|
|
publish : boolean
|
|
qualifiedTypes : Array[string]
|
|
rateSheetCompareOnFileReplaced : boolean
|
|
rateType : string
|
|
scriptWeight : integer
|
|
showCompanyName : boolean
|
|
showInProBrokerLink : boolean
|
|
skipConstructionPeriod : boolean
|
|
states : string
|
|
statesSet : Array[string]
|
|
stepRate : number
|
|
subRateType : string
|
|
timeTracking : TimeTrackingHandler
|
|
useInvestorLockPolicy : boolean
|
|
vaLoanLimitYearOverride : integer
|
|
validAsOf : string
| |
Fault Responses
| Fault | Description |
|---|
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
See Also